Merge pull request #6681 from escattone/get-products-2348

helper function that provides product info

Author: akatsoulas

kitsune/products/tests/test_utils.py

@@ -1,5 +1,5 @@
 from kitsune.products.tests import ProductFactory, TopicFactory
-from kitsune.products.utils import get_taxonomy
+from kitsune.products.utils import get_products, get_taxonomy
 from kitsune.sumo.tests import TestCase
 
 
@@ -408,3 +408,65 @@ def test_specific_product_with_metadata(self):
             ),
             expected,
         )
+
+
+class GetProductsTests(TestCase):
+
+    def setUp(self):
+        ProductFactory(
+            title="product1", description="All about product1...", display_order=1, slug="p1"
+        )
+        ProductFactory(
+            title="product2", description="All about product2...", display_order=2, slug="p2"
+        )
+        ProductFactory(
+            title="product3",
+            description="All about product3...",
+            display_order=3,
+            slug="mozilla-account",
+            visible=False,
+        )
+        ProductFactory(
+            title="product4",
+            description="All about product4...",
+            display_order=4,
+            slug="p4",
+            visible=False,
+        )
+        ProductFactory(
+            title="product5",
+            description="All about product5...",
+            display_order=5,
+            slug="p5",
+            is_archived=True,
+        )
+
+    def test_get_products(self):
+        expected = """products:
+- title: product1
+  description: All about product1...
+- title: product2
+  description: All about product2...
+- title: product3
+  description: All about product3...
+"""
+        self.assertEqual(get_products(), expected)
+
+    def test_get_products_as_json(self):
+        expected = """{
+  "products": [
+    {
+      "title": "product1",
+      "description": "All about product1..."
+    },
+    {
+      "title": "product2",
+      "description": "All about product2..."
+    },
+    {
+      "title": "product3",
+      "description": "All about product3..."
+    }
+  ]
+}"""
+        self.assertEqual(get_products(output_format="JSON"), expected)

kitsune/products/utils.py

@@ -79,3 +79,25 @@ def get_topics(parent=None):
         return json.dumps(result, indent=2, sort_keys=False)
 
     return yaml.dump(result, indent=2, sort_keys=False)
+
+
+def get_products(output_format: str = "YAML") -> str:
+    """
+    Returns the currently active products, each with their title and description,
+    as a string in the output format requested (either "YAML" or "JSON").
+    """
+    products: list[dict[str, str]] = []
+    result = dict(products=products)
+
+    for product in Product.active.filter(Q(visible=True) | Q(slug="mozilla-account")):
+        products.append(
+            dict(
+                title=product.title,
+                description=product.description,
+            )
+        )
+
+    if output_format.lower() == "json":
+        return json.dumps(result, indent=2, sort_keys=False)
+
+    return yaml.dump(result, indent=2, sort_keys=False)